本文是学习GB-T 33784-2017 可编程逻辑器件软件文档编制规范. 而整理的学习笔记,分享出来希望更多人受益,如果存在侵权请及时联系我们
本标准规定了可编程逻辑器件软件开发过程编制的主要文档及其编制的内容、格式等要求。
本标准适用于可编程逻辑器件软件开发过程中文档的编制。
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅注日期的版本适用于本文
件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T 8567—2006 计算机软件文档编制规范
GB/T 11457—2006 软件工程术语
GB/T 33781—2017 可编程逻辑器件软件开发通用要求
GB/T 11457—2006 和 GB/T 33781—2017 中界定的术语和定义适用于本文件。
可编程逻辑器件软件文档应伴随各阶段的工作过程(见GB/T 33781—2017 的表
A.1)而产生。
可编程逻辑器件软件开发过程中要编制的文档应为纸质或电子媒体的形式。
软件文档由封面、签署页、目录、正文组成,必要时增加注释和(或)附录(或附件)。
文档内容的条款标题和顺序应与本标准规定的标题和顺序相同。具体文档编制中,若所编制的文
档不包含本标准规定的某个或某些条款的内容,则在相应条款的标题下直接加以说明,如,"此标题下无
内容"。文档编制的相关具体要求如下:
a) 文档目录:
目录在正文前面。
b) 文档的页码:
文档的目录使用从I
开始的小写罗马数字编号,文档正文和附录使用阿拉伯数字顺序连续编写。
c) 正文条款编号和书写形式:
1) 文档正文的条款编号采用以下形式:
GB/T 33784—2017
X
X.X
X.X.X
X.X.X.X
编号的第1层
编号的第2层
编号的第3层
编号的第4层
其中,X 是阿拉伯数字字符,取值从1到9。
文档条款设置一般最多四层,即编号层次到 X.X.X.X 为止。
2) 在有标题的条款中,正文另起一行书写。
d) 公式:
文档中的公式应写在有关条文附近。公式中符号的意义和计量单位,应注释在公式的下面。同一
个文档中若有两个以上公式时,应在其后用带圆括号的阿拉伯数字顺序编号,编号应在整个文件中
连续。
e) 插图:
文档中插图应安排在有关条文附近(流程图可列在有关章、条之后)。如有两个以上插图,应标以图
号(如,图1-1、图1-2……),图号可用阿拉伯数字1、2…表示,第一个数字表示章号,第二个数字表示顺
序号,图号之后写其名称。
f) 表格:
表格一般排在有关条文附近。同一个文档有两个以上表格时,应在整个文档中连续标注表号(如,
表1-1、表1-2……),表号可用阿拉伯数字1、2…表示,第一个数字表示章号,第二个数字表示顺序号,表
号之后写其名称。
表格中相邻参数或文字相同时,以通栏表示,尽量不使用"同上""同左"字样。
如果表格超过一页要转下页续排时,表的续表不必写表的名称,而在续表的上方居中位置写明"续
表 X"。 续表的表头不得省略。
g) 注和附录:
"注"中不能出现图表和公式。如只有一条注,则在"注"字后面加冒号,接着写注释内容。若同一处
有两条以上注时,可在"注"字加冒号之后,用带圈的阿拉伯数字①、②…标识。
如有两个以上附录,用"附录"加一个英文大写字母的形式编号,编号顺序按英文字母顺序依次
排列。
附录若有标题应写在"附录"后面。
附录的内容、插图、表格应在附录内单独编号。
附录的页码紧接着正文页码连续编排。
在软件开发过程中一般产生下列主要文档:
a) 可编程逻辑器件软件可行性和风险分析报告;
b) 可编程逻辑器件软件开发技术要求;
c) 可编程逻辑器件软件需求规格说明;
d) 可编程逻辑器件软件设计说明;
e) 可编程逻辑器件软件仿真测试计划;
f) 可编程逻辑器件软件仿真测试说明;
g) 可编程逻辑器件软件仿真测试报告;
h) 可编程逻辑器件软件确认测试计划;
i) 可编程逻辑器件软件确认测试说明;
GB/T 33784—2017
j) 可编程逻辑器件软件确认测试报告;
k) 可编程逻辑器件软件使用说明;
1) 可编程逻辑器件软件开发总结报告。
其他文档编制规范参见GB/T 8567—2006。
6.1 可编程逻辑器件软件可行性和风险分析报告
《可编程逻辑器件软件可行性和风险分析报告》描述可编程逻辑器件软件的可行性和风险分析要
求,内容包括:设计复杂度评估、功耗和时钟频率要求评估、防辐照方法、产品测试方法、封装要求、设计
及测试工具(硬件和软件)、必要人力资源的可用性、确认潜在的风险项及对应的预防措施和意外计划。
《可编程逻辑器件软件可行性和风险分析报告》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1 . 3文档概述 2 引用文档 3 工程需求 3.1 功能需求 3.2 性能需求 3 . 3接口需求 3 . 4工作条件 4 可行性分析
|
---|
GB/T 33784—2017
5 继承性分析 6 风险分析
|
---|
《可编程逻辑器件软件开发技术要求》描述可编程逻辑器件软件开发的目的、目标、主要任务、功能
及性能指标等要求,是可编程逻辑器件开发的基础和依据。《可编程逻辑器件软件开发技术要求》应包
括如下内容:
a)
运行环境要求:描述可编程逻辑器件软件运行环境的温度、电压、功耗、抗辐照等方面的要求;
b) 接口关系:描述可编程逻辑器件软件的所有外部接口关系;
c)
安全关键性要求:描述可编程逻辑器件软件可靠性、冗余性、安全性等方面的要求;
d) 设计约束:描述可编程逻辑器件软件IP
核复用要求、资源余量和时序余量等方面的要求;
e)
管理要求:描述可编程逻辑器件软件的管理机构、管理办法、项目开发进度、相关评审、控制节
点等要求;
f)
质量保证:描述可编程逻辑器件标准、文档、配置管理、测试等方面的要求;
g)
验收与交付:描述可编程逻辑器件软件的验收准则,可编程逻辑器件软件的交付形式、数量、装
载媒体,交付的文档清单和(需要时)可编程逻辑器件软件的版权保护等方面的要求;
h)
维护:描述可编程逻辑器件软件验收后出现问题的处理原则,包括可编程逻辑器件软件的改
正、适应和完善性维护工作等方面的要求。
《可编程逻辑器件软件开发技术要求》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述
|
---|
GB/T 33784—2017
1.3 文档概述
2 引用文档 3 运行环境要求 4 任务要求 5 接口关系 6 关键性要求 6.1 可靠性 6 . 2 安 全 性 6.3 保密性 6 . 4其他要求 7 设计约束 8 管理要求 9 质量保证 9.1 标准 9.2 文档 9.3 配置管理
|
---|
GB/T 33784—2017
9.4 测试要求
9 . 5其他要求 10 验收与交付 11 维护
|
---|
《可编程逻辑器件软件需求规格说明》描述可编程逻辑器件软件的功能需求、外部接口需求、内部接
口需求,以及确保满足每个需求所使用的方法。
《可编程逻辑器件软件需求规格说明》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1 . 3文档概述 2 引用文档 3 工程需求 3.1 功能需求 3.1.X (功能名) 3.2 外部接口需求 3.2.1 接口图
|
---|
GB/T 33784—2017
3.2.X (接口功能)
3.3 内部接口需求 3 . 4适应性要求 3.5 容量和时间要求 3.6 安全性要求 3.7 保密性要求 3.8 质量因素 3.9 设计约束 3.10 人的特性/人的工程需求 3.11 可追踪性
|
---|
GB/T 33784—2017
|
---|
《可编程逻辑器件软件设计说明》描述可编程逻辑器件软件的结构/详细设计的技术要求,包括体系
结构设计、功能模块设计及各功能子模块设计、接口设计及各子模块的内部接口关系、设计及约束(包括
综合约束、布局布线约束等)、可追踪性等。
《可编程逻辑器件软件设计说明》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1.3 文档概述 2 引用文档 3 概要设计
|
---|
GB/T 33784—2017
3.1 总体结构原理
3.2 功能模块设计 4 模块设计 4.X 模块名称和项目唯一标识号 5 验证设计 6 可追踪性
|
---|
GB/T 33784—2017
《可编程逻辑器件软件仿真测试计划》描述可编程逻辑器件软件的仿真测试计划的技术要求,包括:
仿真测试环境(仿真测试环境包括功能及时序仿真工具等)、仿真测试要求、测试进度表的安排、可追踪
性等。
《可编程逻辑器件软件仿真测试计划》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1.2.1 可编程逻辑器件软件概述 1.2.2 运行环境 1 . 3文档概述 2 引用文档 3 测试要求与测试策略 3.1 测试总体要求 3.2 测试策略和方法 3.3 测试项和测试子项标识说明 4 测试环境 4.1 仿真测试环境 4.2 软件项
|
---|
GB/T 33784—2017
4.3 硬件和固件项
4.4 安装、测试与控制 4.5 参与组织 4.6 人员 4.7 测试地点 5 测试内容 5.1 测试内容1 5.X 其他测试内容 6 测试进度 7 配置管理计划 8 质量保证计划 9 可追踪性
|
---|
《可编程逻辑器件软件仿真测试说明》描述可编程逻辑器件软件仿真测试所需的测试准备、测试用
例及测试过程。
《可编程逻辑器件软件仿真测试说明》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1.3 文档概述 2 引用文档
|
---|
GB/T 33784—2017
3 测试准备
3.1 硬件准备
3.2 软件准备 3.3 其他测试前准备 4 测试说明 4.X (测试的软件唯一标识符)
|
---|
GB/T 33784—2017
5 可追踪性
|
---|
《可编程逻辑器件软件仿真测试报告》是对可编程逻辑器件软件仿真测试结果的记录,包括测试结
果概述、测试环境的影响、详细的测试结果、测试日志等。
《可编程逻辑器件软件仿真测试报告》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1 . 3文档概述 2 引用文档 3 测试结果概述
|
---|
GB/T 33784—2017
3.2 测试环境的影响 3.3 改进建议 4 详细测试结果 4.X (测试的软件唯一标识符) 4.X.1 测试结果总结 4.X.2 遇到的问题 4.X.3 与测试用例/过程的偏差 5 测试日志
|
---|
《可编程逻辑器件软件确认测试计划》描述可编程逻辑器件软件的确认测试计划的技术要求,包括:
确认测试环境(确认测试环境包括硬件项和软件项、环境条件、辐照要求等)、确认测试要求、测试进度表
GB/T 33784—2017
的安排、可追踪性等。
《可编程逻辑器件软件确认测试计划》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1.2.1 可编程逻辑器件软件概述 1.2.2 运行环境 1.2.3 开发环境 1 . 3文档概述 2 引用文档 3 测试要求与测试策略 3.1 测试总体要求 3.2 测试策略和方法 3.3 测试项和测试子项标识说明 4 测试环境 4.1 确认测试环境 4.2 软件项 4.3 硬件和固件项 4.4 安装、测试与控制 4.5 参与组织
|
---|
GB/T 33784—2017
4.6 人员
4 . 7测试地点 5 测试内容 5.1 测试内容] 5.X 其他测试内容 6 测试进度 7 配置管理计划 8 质量保证计划 9 可追踪性
|
---|
《可编程逻辑器件软件确认测试说明》描述可编程逻辑器件软件确认测试所需的测试准备、测试用
例及测试过程。
《可编程逻辑器件软件确认测试说明》的正文内容要求如下:
1 范围
1.1 标识
1.2 系统概述 1 . 3文档概述 2 引用文档 3 测试准备 3.1 硬件准备
|
---|
GB/T 33784—2017
3.2 软件准备 3.3 其他测试前准备 4 测试说明 4.X (测试的软件唯一标识符)
|
---|
GB/T 33784—2017
5 可 追 踪 性
|
---|
6.10 可编程逻辑器件软件确认测试报告
《可编程逻辑器件软件确认测试报告》是对可编程逻辑器件软件确认测试结果的记录,包括测试结
果概述、测试环境的影响、详细的测试结果、测试日志等。
《可编程逻辑器件软件确认测试报告》的正文内容要求如下:
1 范围
1 . 1 标 识
1 . 2系统概述 1.3 文档概述 2 引 用 文 档 3 测试结果概述 3.2 测试环境的影响
|
---|
GB/T 33784—2017
3.3 改进建议
4 详细测试结果 4.X (测试的软件唯一标识符) 4.X.1 测试结果总结 4.X.2 遇到的问题 4.X.3 与测试用例/过程的偏差 5 测试日志
|
---|
《可编程逻辑器件软件使用说明》描述可编程逻辑器件软件适用的系统和可编程逻辑器件项目。
《可编程逻辑器件软件使用说明》应包括如下内容:
a)
芯片概述:描述可编程逻辑器件软件的芯片型号、配置芯片型号、开发环境、配置文件版本
号等;
b) 性能指标:描述可编程逻辑器件软件的工作时钟频率、工作电压、功能等;
c)
环境要求:描述可编程逻辑器件软件的工作温度要求、器件等级、抗辐照性能等;
d) 物理特性:描述可编程逻辑器件软件的芯片封装、管脚分配等;
e) 使用说明:描述可编程逻辑器件软件的通讯协议、操作时序等。
《可编程逻辑器件软件使用说明》的正文内容要求如下:
GB/T 33784—2017
1 范围
1.1 标识
1 . 2芯片概述 1.3 文档概述 2 引用文档 3 功能概述 3.X 功能标识和功能描述 4 主要技术指标 4.1 性能指标 4.2 环境要求 5 物理特性
|
---|
GB/T 33784—2017
6 使用说明
6.X XX功能使用说明 7 固化
|
---|
6.12 可编程逻辑器件软件开发总结报告
《可编程逻辑器件软件开发总结报告》描述可编程逻辑器件软件整个研制/开发情况。《可编程逻辑
器件软件开发总结报告》应包括如下内容:
a) 任务来源与研制依据;
b) 可编程逻辑器件软件概述;
c)
可编程逻辑器件软件研制过程:描述可编程逻辑器件软件研制过程的概述以及可编程逻辑器
件软件研制各活动/阶段所采用的方法和工作产品等;
d) 可编程逻辑器件软件满足任务指标情况;
e)
可编程逻辑器件软件测试情况:描述可编程逻辑器件软件的仿真测试、确认测试、实验测试、验
收测试、系统联试等;
f) 可编程逻辑器件软件第三方评测情况;
g)
质量保证情况:描述质量保证措施实施情况、可编程逻辑器件软件重大技术质量问题和解决情
况等;
h)
配置管理情况:描述可编程逻辑器件软件配置管理要求、可编程逻辑器件软件配置管理实施情
况、可编程逻辑器件软件配置状态变更情况等;
i)
可编程逻辑器件软件可靠性、安全性分析:描述可编程逻辑器件可靠性、安全性要求所采用的
措施分析;
j)
结论:评述可编程逻辑器件软件工程化实施情况,说明可编程逻辑器件软件功能和性能指标是
否满足可编程逻辑器件软件开发技术要求的要求,给出可编程逻辑器件软件是否可以交付需
方使用的结论。
《可编程逻辑器件软件开发总结报告》的正文内容要求如下:
GB/T 33784—2017
1 范围
1.1 标识
1.2 系统概述 1 . 3文档概述 3 可编程逻辑器件软件概述 4 可编程逻辑器件软件研制过程 6 可编程逻辑器件软件测试 6.1 测试情况 6.2 问题处理情况 6.3 测试覆盖情况
|
---|
GB/T 33784—2017
7 第三方评测
8 质量保证情况 8.1 质量保证措施实施情况 9 配置管理情况 10.1 可靠性分析 10 .2安全性分析 11 结论
|
---|
更多内容 可以 GB-T 33784-2017 可编程逻辑器件软件文档编制规范. 进一步学习